Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

id
integer<int32>
required

The id of the referenced Warehouse.

Query Parameters

fields
enum<string>[]

Specify additional fields of the ReplenishmentReport object to be included in the response.

Available options:
basic,
all,
product,
policy,
policy_id,
policy_name,
location_profile,
location_profile_id,
location_profile_name,
profile_revision_id,
group_qty,
assigned_count,
warehouse_qty,
available_to_move,
daily_demand,
doi_days,
trigger_doi_days,
target_doi_days,
shortfall_qty,
is_flagged,
presence,
computed_at
fields:product
enum<string>[]

Specify additional common fields of the Product or stockable Packaging* object referenced by each Replenishment Report row. See the selecting fields page for more information. Specify additional common fields of the Product or stockable Packaging* object referenced by a Replenishment Report row.

Available options:
basic,
all,
vendor_sku,
manufacturer_part_number,
external_id,
barcodes,
goods_type,
is_available,
is_visible,
created_at,
updated_at,
weight,
dimensions,
volume,
inventory,
export,
regulated_goods,
packaging,
custom_fields
fields:product.merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand,
custom_fields
fields:policy
enum<string>[]

Specify direct fields of the ReplenishmentPolicy referenced by each Report row. Subject relationships, counters, and the Policy's own Location Profile expansion are intentionally unavailable through this endpoint. See the selecting fields page for more information. Specify direct fields of the included ReplenishmentPolicy object.

Available options:
name,
is_active,
sort_order,
demand_period_days,
trigger_doi_days,
target_doi_days,
qualification_reason,
created_at,
updated_at
fields:location_profile
enum<string>[]

Specify direct summary fields of the LocationProfile referenced by each Report row. Match definitions, usage details, and nested tag/type relationships are intentionally unavailable through this endpoint. See the selecting fields page for more information. Specify direct summary fields of the included LocationProfile object.

Available options:
name,
description,
status,
member_count,
created_at,
updated_at
filter
string[]

Using the filtering syntax, you may filter the results using the following fields:

  • id
  • sku
  • merchant_id
  • is_flagged
  • presence
  • policy_id
  • location_profile_id
  • profile_revision_id
  • doi_days
  • shortfall_qty
  • computed_at
sort
string

The default sort order is ascending by primary key (sort=id). Every sort carries an ascending id tie-break, because none of the other sortable values are unique. sku ordering joins the Product catalog, so it is intended for filtered or bounded result sets. The following fields are available for sorting:

  • id
  • sku
  • doi_days
  • shortfall_qty
  • daily_demand
  • computed_at
count
integer

If specified as 1, the meta.count property of the response will be present and populated with the total count of items matching the query before any paging is applied. This is not included by default to improve performance in some edge cases and is not required to perform paging using the next property of the response. See paging parameters for more information.

Required range: 0 <= x <= 1
cursor_end
integer

A cursor for use in pagination which defines the last id of the next page of results, non-inclusive. See paging parameters for more information on paging.

cursor_start
integer

A cursor for use in pagination which defines the starting id of the next page of results. See paging parameters for more information on paging.

limit
integer
default:100

A limit on the number of objects to be returned.

Required range: 1 <= x <= 1000
Example:

100

Response

A dictionary with a collection property that contains a list of up to limit ReplenishmentReport objects matching the query.

collection
ReplenishmentReport · object[]

A list of ReplenishmentReport objects.

included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.

Example:
has_more
boolean

True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.

next
string | null

The resource path for the next page of results if any are expected.

previous
string | null

The resource path for the previous page of results if any are expected.

meta
object

Additional metadata pertaining to the response.